TimePunch Authentication Service
Dieser Service erlaubt den Zugriff auf die Benutzerprofile von TimePunch.
IsDatabaseValid
Diese Methode überprüft die Datenbankstruktur der übergebenen Module. Sollte die Datenbankstruktur eines Moduls nicht passen, dann wird eine entsprechende Fehlermeldung im Fault Objekt zurückgegeben.
void IsDatabaseValid(
TpAuthentication authentication,
string[] moduleKeys,
out TpFault fault);
| Needed Permission | --- | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. AuthenticationFailure.TimePunchOutdated AuthenticationFailure.OldDatabaseVersion AuthenticationFailure.NoDatabaseConnection AuthenticationFailure.UnexpectedException |
| authentication | User authentication | |
| moduleKeys | List of module identifier to check the database structure |
Das zurückgegebene Fault Objekt ist vom Typ TpAuthenticationFault
Aktuell sind folgende Modulschlüssel bekannt:
| Schlüssel | Modul |
|---|---|
| Datafox | Datafox – Zeiterfassungsgeräte |
| Attendance | TimePunch Attendance – Anwesenheitsliste |
| Cutter | TimePunch Cutter – Rahmenarbeitszeiten |
| Calendar | TimePunch Calendar – Abwesenheitskalender |
| SelfService | TimePunch SelfService – Selbstauskunft |
| Online | TimePunch Online - Mobile Zeiterfassung |
| Studio | TimePunch Studio - Zeiterfassung am zentralen Service PC |
| Watcher | TimePunch Watcher - Zeiterfassung am eigenen PC |
| Management | TimePunch Management - Mitarbeiter und Arbeitszeit verwalten |
ValidateAuthentication
Diese Methode überprüft die angegebenen Anmeldedaten und gibt nach der erfolgreichen Validierung die Benutzerrechte zurück. Wichtig ist hierbei, dass auch die Benutzerlizenz gegen die übergebenen Applikationsschlüssel geprüft wird. Wird kein Applikationsschlüssel mitgegeben, so wird nur geprüft, ob der Anwender überhaupt eine Lizenz besitzt – unabhängig davon welche es ist.
ValidatedAuthenticationDto ValidateAuthentication (
out TpFault fault,
TpAuthentication authentication
string[] applicationKeys);
| Needed Permission | core@logon | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| applicationKeys | Keys of the application for which the license informations shall be validated. | |
| return value | Validated authentication object, containing a collection of the user permissions |
Die Applikationsschlüssel sind in der Klasse TimePunch.Enums.Core.ApplicationKeys als Konstanten definiert.
ValidateAuthenticationWithProductLine
Diese Methode überprüft die angegebenen Anmeldedaten und gibt nach der erfolgreichen Validierung die Benutzerrechte zurück. Wird kein Applikationsschlüssel mitgegeben, so wird nur geprüft, ob der Anwender überhaupt eine Lizenz besitzt – unabhängig davon welche es ist.
Zusätzlich gibt diese Methode die lizenzierte Produktlinie zurück.
ValidatedAuthenticationDto ValidateAuthenticationWithProductLine(
out TpFault fault,
TpAuthentication authentication,
string[] applicationKeys,
out ProductLine licensedProductLine);
| Needed Permission | core@logon | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| applicationKeys | Keys of the application for which the license informations shall be validated. | |
| LicensedProductLine | Out | Productline that is used by the user. Undefined Currently no product line is set TimePunchPro Licensed for TimePunch PRO TimePunchOne Licensed for TimePunch ONE TimePunchTen Licensed for TimePunch TEN |
| return value | Validated authentication object, containing a collection of the user permissions |
Die Applikationsschlüssel sind in der Klasse TimePunch.Enums.Core.ApplicationKeys als Konstanten definiert.
GetPrincipalAndIdentityProfile
Diese Methode ermittelt den Principal (den Rechteinhaber), sowie die verwendete Identity (die Benutzer-Identität).
void GetPrincipalAndIdentityProfile(
out TpFault fault,
TpAuthentication authentication,
out UserProfileDto principalDto,
out UserProfileDto identityDto);
| Needed Permission | core@logon | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| principalDto | Out | Returns the principal object, which is the user that is used for permissioning in TimePunch. |
| identityDto | Out | Returns the identity object, which is the user to whom the changes/modifications or commands are applied. |
GetCoveredUserProfiles
Diese Methode ermittelt alle Benutzerprofile die der Benutzer administrieren darf. Alle Profile die bei dieser Methode zurückgegeben werden, können als Identity Parameter für das Authentifizierungs-Objekt genutzt werden.
List<UserProfileDto> GetCoveredUserProfiles(
out TpFault fault,
TpAuthentication authentication);
| Needed Permission | core@logon | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| return value | Collection of the user profiles that the given authentication can administrate. |
GetEntitledUserProfiles
Mit dieser Methode können alle verfügbaren Benutzerprofile abgerufen werden. Das Ergebnis des Aufrufs ist unabhängig vom aktuellen Benutzer.
Hinweis: Diese Methode wird nur noch bis Version 2.9 unterstützt. Ab Version 3.2 muss die neue Methode SearchAuthorizedUsers verwendet werden.
List<UserProfileDto> GetEntitledUserProfiles(
out TpFault fault,
TpAuthentication authentication);
| Needed Permission | core@logon (if server logon is with username) | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| return value | Collection of the user profiles that are authorized to use TimePunch. |
GetLicensedUserProfiles
Diese Methode liefert alle Benutzerprofile zurück, für die eine aktive Lizenz vorhanden ist. Wichtig ist hierbei, dass auch die Benutzerlizenz gegen die übergebenen Applikationsschlüssel geprüft wird. Wird kein Applikationsschlüssel mitgegeben, so wird nur geprüft, ob der Anwender überhaupt eine Lizenz besitzt – unabhängig davon welche es ist.
List<UserProfileDto> GetLicensedUserProfiles (
out TpFault fault,
TpAuthentication authentication,
string[] applicationKeys);
| Needed Permission | core@logon (if server logon is with username) | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| applicationKeys | Keys of the application for which the license informations shall be validated. | |
| return value | Collection of the user profiles that own a valid TimePunch license. |
Die Applikationsschlüssel sind in der Klasse TimePunch.Enums.Core.ApplicationKeys als Konstanten definiert.
SearchAuthorizedUsers
Mit Hilfe dieser Methode kann nach Mitarbeitern gesucht werden, die sich im System anmelden dürfen. Dies sind prinzipiell alle Mitarbeiter die Zugriff auf TimePunch besitzen.
List<UserProfileDto> SearchAuthorizedUsers(
out TpFault fault,
TpAuthentication authentication,
UserSearchDto userSearchDto);
| Needed Permission | core@logon (if server logon is with username) | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| userSearchDto | Search object that specifies what to search for. | |
| return value | Collection of the user profiles that are authorized to use TimePunch. |
SearchUserLogons
Mit Hilfe dieser Methode können erweiterte Informationen zu den Mitarbeiterprofilen gesucht werden. Zu den Standarddaten des Mitarbeiterprofiles werden die Rechte, die erste und letzten Eintragsdaten sowie die Information über den Status des Profils zurückgegeben.
List<UserLogonDto> SearchUserLogons(
out TpFault fault,
TpAuthentication authentication,
UserSearchDto userSearchDto)
| Needed Permission | userProfiles@access | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| userSearchDto | Search object that specifies what to search for. | |
| return value | Collection of the user profiles that are authorized to use TimePunch. |
SetPassword
Diese Methode setzt das Anmeldepasswort für einen Mitarbeiter. Das Passwort wird dabei für den Mitarbeiter im Authentication Objekt gesetzt.
void SetPassword(
out TpFault fault,
TpAuthentication authentication,
string newHashedPwd);
| Needed Permission | password@manage | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| newHashedPwd | New Password. The password must already been hashed with the MD5 algorithm. |
GetAutoRegistration
Diese Methode gibt interne Informationen über das Auto-Registration Feature von TimePunch zurück. Dieses Feature erlaubt es neuen Mitarbeitern sich direkt in TimePunch anzumelden, ohne das Profil vorher in TimePunch durch einen Administrator anlegen zu lassen.
AutoregistrationDto GetAutoRegistration(
out TpFault fault,
TpAuthentication authentication);
| Needed Permission | --- | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| return value | Information about the auto-registration feature of TimePunch. |
SaveAutoRegistration
Mit dieser Methode kann das Auto-Registration Feature von TimePunch gesetzt oder verändert werden.
void SaveAutoRegistration(
out TpFault fault,
TpAuthentication authentication,
AutoregistrationDto autoregistration);
| Needed Permission | core@administrate | |
|---|---|---|
| Name | Modifier | Description |
| fault | Out | Contains the error if an exception occurs. |
| authentication | User authentication | |
| autoregistration | Information about the auto-registration feature of TimePunch |